VS Code extension: Auto-restore on workspace open and config change by adamint · Pull Request #15546 · microsoft/aspire

adamint · 2026-03-24T20:58:02Z

Description

Adds automatic aspire restore execution in the VS Code extension to keep integration packages in sync with aspire.config.json.

Problem: When switching git branches that have different Aspire integrations configured, the editor shows squiggly errors until you manually run aspire restore. This is a common friction point during development.

Solution: The new AspirePackageRestoreProvider automatically runs aspire restore:

On workspace open — restores all aspire.config.json files found in the workspace
On config content change — a FileSystemWatcher monitors aspire.config.json files; when content actually changes (e.g., branch switch, manual edit), it runs restore

Features

Concurrency-limited parallel restore — up to 4 concurrent restores, with progress shown in the status bar (Running aspire restore (2/5 projects) ...)
Status bar feedback — spinner during restore, checkmark on completion, error icon with red background on failure
Clickable status bar — clicking the status bar item runs the aspire restore command in the Aspire terminal
Aspire: Restore command — new command palette entry (aspire-vscode.restore) to manually trigger restore
Pending restore queue — if a config file changes while restore is already running for that directory, it queues a re-restore instead of dropping the change
Content-based change detection — only triggers restore when aspire.config.json content actually changes, not on every file-save event
Baseline tracking — _lastContent is only updated after a successful restore, so failures don't prevent retries on the next change
Configurable — controlled by aspire.enableAutoRestore setting (default: true); toggling the setting on immediately starts watching and restoring
Timeout protection — restores time out after 2 minutes with proper cleanup
Graceful disposal — kills child processes, clears timeouts, and disposes watchers on extension deactivation

Testing

I tested this using:

The playground folder, since there are over a hundred TS apphosts. The apphosts are restored slowly, respecting the concurrency limit. This should not be an issue in practice, as the likelihood of a repo having hundreds of apphosts is low.
A separate local git repo where one branch had a redis package entry, and another branch had redis + PostgreSQL — switching branches triggers restore automatically.

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
- No
Does the change make any security assumptions or guarantees?
- Yes
- No
Does the change require an update in our Aspire docs?
- Yes
- No

github-actions · 2026-03-24T20:58:45Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15546

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15546"

Copilot

Pull request overview

Adds an auto-restore mechanism to the VS Code extension so aspire restore is run automatically to keep integration packages in sync with aspire.config.json, reducing editor squiggles after branch switches/config edits.

Changes:

Introduces AspirePackageRestoreProvider to run aspire restore on workspace open and on aspire.config.json changes (with a concurrency cap and status bar progress).
Adds the aspire.enableAutoRestore setting (default true) plus localized strings for restore progress and results.
Updates TypeScript playground aspire.config.json files and refreshes generated AppHost .modules outputs.

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
playground/TypeScriptApps/RpsArena/aspire.config.json	Moves package versions to `13.2.0` and removes daily SDK/channel fields.
playground/TypeScriptApps/AzureFunctionsSample/aspire.config.json	Adds `appHost` metadata and moves package versions to `13.2.0`.
playground/TypeScriptApps/AzureFunctionsSample/AppHost/.modules/transport.ts	Updates generated transport layer (cancellation, marshalling, connection/auth flow).
playground/TypeScriptApps/AzureFunctionsSample/AppHost/.modules/base.ts	Updates generated base SDK types (ReferenceExpression enhancements, transport value serialization).
playground/TypeScriptApps/AzureFunctionsSample/AppHost/.modules/.codegen-hash	Updates codegen hash to reflect regenerated modules.
extension/src/utils/settings.ts	Adds accessor for `enableAutoRestore`.
extension/src/utils/AspirePackageRestoreProvider.ts	New provider that runs/monitors `aspire restore` and shows status bar progress.
extension/src/loc/strings.ts	Adds localized runtime strings for restore progress/results.
extension/src/extension.ts	Wires up the new auto-restore provider during activation.
extension/package.nls.json	Adds localized description for the new setting and restore messages.
extension/package.json	Defines the new `aspire.enableAutoRestore` configuration setting.
extension/loc/xlf/aspire-vscode.xlf	Adds localization units for new strings/setting description.

playground/TypeScriptApps/AzureFunctionsSample/AppHost/.modules/transport.ts

extension/src/utils/AspirePackageRestoreProvider.ts

extension/src/extension.ts

playground/TypeScriptApps/RpsArena/aspire.config.json

extension/package.nls.json

extension/src/utils/AspirePackageRestoreProvider.ts

extension/src/loc/strings.ts

extension/src/utils/AspirePackageRestoreProvider.ts

JamesNK

Code review — focused on problems only. 5 inline comments on the new AspirePackageRestoreProvider.

extension/src/utils/AspirePackageRestoreProvider.ts

…g restores, separate errors, fix timeout leak, handle unhandled promise

Co-authored-by: Ankit Jain <radical@gmail.com>

… status bar - Fix floating promises in watcher handlers (void + catch) - Fix timing bug: .finally() runs before _hadFailure is updated - Extract _scheduleHide() for status bar auto-hide logic - Add explicit _showProgress() call on success path - Only update _lastContent after successful restore - Add settled flag to prevent double resolve/reject - Add try/catch around proc.kill() - Replace magic numbers with named constants - Fix space before ellipsis in localized strings - Wire up AspirePackageRestoreProvider in extension.ts - Add aspire-vscode.restore command - Show failure state in status bar with error background - Make status bar item clickable (runs restore command)

- Early returns (file-read failure, unchanged content) now increment _completed so the progress bar doesn't get stuck - Skip _total increment when a re-restore is already queued for the same directory, preventing counter inflation from duplicate events

- Guard counter mutations during batch with _batchRunning flag - Replace single _hadFailure boolean with per-directory _failedDirs set - Use single _hideTimeout reference instead of accumulating timeouts - Change recursive pending-restore tail call to iterative while loop Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK · 2026-03-29T13:59:12Z

extension/src/utils/AspirePackageRestoreProvider.ts

+        }
+    }
+
+    private async _runRestore(configDir: string, relativePath: string): Promise<void> {


Bug: _active leaks if getAspireCliExecutablePath() throws.

_active.set(configDir, ...) happens before the await that can throw, but the cleanup in .finally() is on the inner Promise that is never constructed when the CLI path resolution fails. This leaves configDir permanently stuck in _active, so:

Every future watcher event for that directory takes the _active.has(configDir) branch, adds to _pendingRestore, and returns immediately.

The while (this._pendingRestore.delete(configDir)) loop in the caller can spin infinitely — the pending restore re-enters _restoreIfChanged, sees the stale _active entry, re-adds to _pendingRestore, returns, and the while loop keeps going.

Suggest wrapping the entire body of _runRestore in try/finally:

private async _runRestore(configDir: string, relativePath: string): Promise<void> { this._active.set(configDir, relativePath); this._showProgress(); try { const cliPath = await this._terminalProvider.getAspireCliExecutablePath(); await new Promise<void>((resolve, reject) => { // ... existing spawning logic ... }); } finally { this._active.delete(configDir); this._completed++; this._showProgress(); } }

JamesNK · 2026-03-29T13:59:22Z

extension/src/utils/AspirePackageRestoreProvider.ts

+        if (!this._pendingRestore.has(configDir) && !this._batchRunning) {
+            if (this._active.size === 0 && this._completed >= this._total) {
+                this._total = 1;
+                this._completed = 0;
+                this._failedDirs.clear();
+            } else {
+                this._total++;


Bug: progress counters desync when a watcher fires during _restoreAll().

When _batchRunning is true, _total is not incremented here. But if the watcher's restore actually runs (e.g. different directory with no active restore), _completed still gets incremented in _runRestore's .finally(). This causes _completed > _total, so the status bar can show progress like "5/4 projects".

One fix: always increment _total when the restore will actually proceed, regardless of _batchRunning. Or track watcher-triggered restores with a separate counter from the batch.

JamesNK · 2026-03-29T13:59:34Z

extension/src/extension.ts

@@ -69,6 +70,7 @@ export async function activate(context: vscode.ExtensionContext) {
  const settingsCommandRegistration = vscode.commands.registerCommand('aspire-vscode.settings', () => tryExecuteCommand('aspire-vscode.settings', terminalProvider, settingsCommand));
  const openLocalSettingsCommandRegistration = vscode.commands.registerCommand('aspire-vscode.openLocalSettings', () => tryExecuteCommand('aspire-vscode.openLocalSettings', terminalProvider, openLocalSettingsCommand));
  const openGlobalSettingsCommandRegistration = vscode.commands.registerCommand('aspire-vscode.openGlobalSettings', () => tryExecuteCommand('aspire-vscode.openGlobalSettings', terminalProvider, openGlobalSettingsCommand));


Clicking the error status bar doesn't clear the error state.

The command runs sendAspireCommandToAspireTerminal('restore'), which executes in the integrated terminal — completely separate from AspirePackageRestoreProvider's internal state. Even if the manual terminal restore succeeds, _failedDirs is never cleared, so the error icon persists indefinitely. Only a file content change that triggers a successful automatic restore clears it.

Consider either:

Having the restore command also clear _failedDirs and re-trigger _restoreAll(), or

Wiring the status bar command to a method on AspirePackageRestoreProvider instead of the terminal command.

Copilot AI review requested due to automatic review settings March 24, 2026 20:58

Copilot started reviewing on behalf of adamint March 24, 2026 21:00 View session

adamint self-assigned this Mar 24, 2026

adamint added the area-extension label Mar 24, 2026

Copilot AI reviewed Mar 24, 2026

View reviewed changes

adamint mentioned this pull request Mar 24, 2026

Remove checked-in .modules folders and add to .gitignore #15549

Merged

16 tasks

github-actions bot mentioned this pull request Mar 24, 2026

[pull requests] Review required #13834

Open

adamint requested a review from mitchdenny March 25, 2026 05:07

radical reviewed Mar 25, 2026

View reviewed changes

JamesNK reviewed Mar 26, 2026

View reviewed changes

adamint requested review from danegsta, davidfowl, eerhardt, karolz-ms and sebastienros as code owners March 28, 2026 21:24

adamint and others added 6 commits March 28, 2026 16:43

update playground aspire configs

7965cb1

Implement automatic package restore

39061ab

Address PR review comments: fix activate() early return, queue pendin…

2e0c535

…g restores, separate errors, fix timeout leak, handle unhandled promise

Update extension/package.nls.json

9b0f6e8

Co-authored-by: Ankit Jain <radical@gmail.com>

adamint force-pushed the dev/adamint/run-aspire-restore-branch-switch-workspace-open branch from 1c0e42c to 8a23f34 Compare March 28, 2026 23:44

JamesNK reviewed Mar 29, 2026

View reviewed changes

Conversation

adamint commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Features

Testing

Checklist

Uh oh!

github-actions bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JamesNK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JamesNK Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adamint commented Mar 24, 2026 •

edited

Loading

github-actions bot commented Mar 24, 2026 •

edited

Loading